CustomerApi Odata Help Page

Customer - Segmentation

Manage the segment types entities.

Required HTTP Headers

X-Crm360Api-Token
X-Crm360Api-CustomerName
X-Crm360Api-DatabaseAlias

Functions

Create
Read
Update
Delete
Translate

Entity Properties

Name	Type	Is Mandatory
SegmentationId	Int32
Label	String
Identifier	String
SourceId	Int16
SegmentationTypeId	Int16
DeletionFlag	Boolean
ProcessDate	DateTime
Segments	Collection of Segment
SegmentTypes	Collection of SegmentType
Source	Source

Examples

Select all Segmentations
https://customerapi.fts-crm360.com/data/Segmentations()
HttpMethod : GET                                                                                       
Json Result : 

[
{
"SegmentationId" : "31",
"Label" : "Nh7FGv",
"Identifier" : "bfvVm",
"SourceId" : "9",
"SegmentationTypeId" : "3",
"DeletionFlag" : "False",
"ProcessDate" : "2020-08-21T00:00:00"
},
{
"SegmentationId" : "72",
"Label" : "nH BO",
"Identifier" : "owyZwCC6vI",
"SourceId" : "5",
"SegmentationTypeId" : "5",
"DeletionFlag" : "False",
"ProcessDate" : "2008-06-16T00:00:00"
},
...
]

Select Segmentation by Id
https://customerapi.fts-crm360.com/data/Segmentations(31)
HttpMethod : GET                                                                                       
Json Result : 

{
"SegmentationId" : "4",
"Label" : "2HtDJi",
"Identifier" : "Ji O7cKOLSlcW8o",
"SourceId" : "7",
"SegmentationTypeId" : "5",
"DeletionFlag" : "False",
"ProcessDate" : "2007-01-28T00:00:00"
}

Create a Segmentation
https://customerapi.fts-crm360.com/data/Segmentations()
HttpMethod : POST                                                                                                
Json Post :
{
"Label" : "ywxuQ fQrUJLEBn1Wz",
"Identifier" : "dj4VPh",
"SourceId" : "9",
"SegmentationTypeId" : "7",
"DeletionFlag" : "False",
"ProcessDate" : "2001-09-16T00:00:00"
}
            
Informations : 
 - Non mandatory fields are optional for Json Post

Update a Segmentation
https://customerapi.fts-crm360.com/data/Segmentations(31)
HttpMethod : PUT                                                                                                
Json Post :
{
"SegmentationId" : "45",
"Label" : "Xuq6Yxr9",
"Identifier" : "74h2H XTUxUok6S4ag",
"SourceId" : "2",
"SegmentationTypeId" : "3",
"DeletionFlag" : "True",
"ProcessDate" : "2005-07-05T00:00:00"
}
            
Informations : 
 - Non mandatory fields are optional for Json Post

Patch a Segmentation
https://customerapi.fts-crm360.com/data/Segmentations(31)
HttpMethod : PATCH                                                                                                
Json Post :
{
"Label" : "ODyb",
"SourceId" : "2"
}
            
Informations : 
 - Non mandatory fields are optional for Json Post

Delete a Segmentation
https://customerapi.fts-crm360.com/data/Segmentations(31)
HttpMethod : DELETE

Translate a Segmentation label
https://customerapi.fts-crm360.com/data/Segmentations(31)/Label
HttpMethod : GET                                                                                       
Required Fields : 
Http Header for language : X-Crm360Api-Language-3